Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bidirectional pagination #26166

Merged

Conversation

perunt
Copy link
Contributor

@perunt perunt commented Aug 29, 2023

It's a part of the 'comment linking' feature. In this PR, we're only addressing the ability to fetch elements from both sides. There's no gap detection here (by 'gap detection,' I mean distinguishing where we have inconsistent messages and fetching the proper piece of them). Right now, it only fetches an element if it reaches the start or end of the list

Details

Fixed Issues

$ #23223
PROPOSAL:

Tests

  • Verify that no errors appear in the JS console

Offline tests

QA Steps

Open Chat:

  1. Navigate to the chat section of the application.
  2. Ensure that the chat interface is displayed correctly.

Check for Absence of Bottom Loader:

  1. Upon initial load, observe the bottom of the chat list.
  2. Expected Result: There should be no loading indicator or spinner at the bottom of the chat list.

Scroll to the Top:

  1. Scroll to the top of the chat list.
  2. Expected Result: As you approach the top, you should see a "skeleton loader".

Scroll Back to the Bottom:

  1. After observing the skeleton loader at the top, scroll back down to the bottom of the chat list.
  2. Expected Result: As you approach the bottom, you should now see an "activity indicator" or a spinner. This indicates that older chat messages or content are being loaded.
  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
Untitled.2.mov
Mobile Web - Chrome
telegram-cloud-document-2-5210708448685077299.mp4
Mobile Web - Safari
111.mov
Desktop
11.mov
iOS
Simulator_Screen_Recording_iPhone_14_Pro_2023_09_18_at_15_58_51.mov
Android
telegram-cloud-document-2-5210708448685076822.mp4

@perunt perunt marked this pull request as ready for review September 19, 2023 17:16
@perunt perunt requested a review from a team as a code owner September 19, 2023 17:16
@melvin-bot melvin-bot bot requested review from pecanoro and removed request for a team September 19, 2023 17:17
@melvin-bot
Copy link

melvin-bot bot commented Sep 19, 2023

@pecanoro Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@pecanoro
Copy link
Contributor

@perunt Is there any issue to link to this PR?

@perunt
Copy link
Contributor Author

perunt commented Sep 20, 2023

yes, added to the description. I'll also add the main issue link for clarification, thanks!

@roryabraham
Copy link
Contributor

@pecanoro I can help review this one since I have context.

@perunt
Copy link
Contributor Author

perunt commented Oct 23, 2023

@roryabraham I'm back from my vacation, so I'll put all my efforts to deliver comment linking asap.
The PR is up to date and ready for testing

src/pages/home/ReportScreen.js Show resolved Hide resolved
src/pages/home/report/ReportActionsList.js Outdated Show resolved Hide resolved
@pecanoro
Copy link
Contributor

Just two small styling changes, everything else looked good to me

@perunt perunt marked this pull request as draft October 24, 2023 12:14
@perunt perunt marked this pull request as ready for review October 24, 2023 12:56
@roryabraham
Copy link
Contributor

Going to go ahead and merge since it seems all of @pecanoro's concerns have been addressed and she said:

everything else looked good to me

Thanks so much to everyone for the help reviewing this. Thanks @perunt for your hard work on the PR!

@roryabraham roryabraham merged commit 485a851 into Expensify:main Oct 24, 2023
14 checks passed
@OSBotify
Copy link
Contributor

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/roryabraham in version: 1.3.91-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@iwiznia
Copy link
Contributor

iwiznia commented Oct 26, 2023

This PR caused #30423

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/marcaaron in version: 1.3.91-8 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

Comment on lines +419 to +420
onStartReached={loadNewerChats}
onStartReachedThreshold={0.75}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

May I ask why this is needed?
I mean why we need to load newer actions? When we open report, I think we get all the latest actions.
@perunt Will you explain?

@aldo-expensify
Copy link
Contributor

I think this is very likely causing this: #30729
The bottom spinner under some conditions can appear after sending a message

@roryabraham
Copy link
Contributor

We also had caused #30395, which we fixed by adding autoScrollToTopThreshold

onyxMethod: Onyx.METHOD.MERGE,
key: `${ONYXKEYS.COLLECTION.REPORT_METADATA}${reportID}`,
value: {
isLoadingNewerReportActions: true,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused a regression when we try to load more while the device is offline it will cause a loop setting the value of isLoadingNewerReportActions creating a flicker #30503

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

10 participants